home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 June / EnigmA AMIGA RUN 08 (1996)(G.R. Edizioni)(IT)[!][issue 1996-06][EARSAN CD VII].iso / earcd / utmisc2 / cookies.lha / Cookies / Cookies.doc < prev    next >
Text File  |  1996-05-08  |  9KB  |  254 lines
  1.  
  2. Cookies version 0.41
  3. ====================
  4.  
  5.  
  6. 1. What is Cookies?
  7. -------------------
  8. Cookies is two things:
  9. a/ A little fortune cookie program (can be quite funny)
  10. b/ A complete waste of disk space (it isn't particularly useful)
  11.  
  12.  
  13. 2. Installing Cookies
  14. ---------------------
  15. Umm, this is *really* tricky :-)  Just drag the Cookies and Cookies.txt icons
  16. to where-ever you wanna put the program.  Works off floppy or hard drive.
  17. There are no assigns to put in Startup-Sequence or anything.  This is a good
  18. thing because no-one would want to bother with assigns for a fortune cookie
  19. program.
  20.  
  21. In addition, if you want to use the program from Workbench, then
  22. reqtools.library must be installed in LIBS:  Cookies needs version 38 or
  23. above of reqtools.library.  This version has been included in the archive.
  24. If you already have reqtools.library v38 or above installed, do *not*
  25. reinstall from this version.  However, if you do not have reqtools.library
  26. installed, or have an old version, you should copy the supplied version into
  27. your LIBS: directory.  The version supplied will work on all versions of
  28. AmigaOS from 1.3 up.
  29.  
  30.  
  31. 3. Using Cookies
  32. ----------------
  33.  
  34. A. From Workbench
  35.  
  36. Double click on the icon.  The program will check that Cookies.txt is in the
  37. current directory and will refuse to run if it isn't.  Assuming you followed
  38. the highly technical installation procedure outlined above, Cookies will open
  39. its window and display a random message from the text file.
  40.  
  41. The Cookies window has four buttons along the bottom; these are:
  42. ANOTHER   SPECIFIC   ABOUT   QUIT
  43.  
  44. Clicking ANOTHER will pick another cookie at random and display it.
  45.  
  46. By clicking SPECIFIC, you can pick a cookie from the file to display.  It
  47. will open a window with a prompt in; you then enter the cookie number that
  48. you want.  For example, if Cookies.txt contains 100 cookies, you can enter a
  49. number from 1 to 100.  So, if you have a lucky number, you can see which
  50. cookie it corresponds to!
  51.  
  52. Clicking ABOUT opens a window with the program credits in.
  53.  
  54. Clicking QUIT err... quits.
  55.  
  56. You can run Cookies from your WBStartup drawer.  Just drag its icon into
  57. the drawer, along with Cookies.txt.  WARNING: if you do this, you must
  58. delete Cookies.txt's icon using the Shell.  To recap: to run the program
  59. from WBStartup, the following three files have to go in the drawer:
  60.   Cookies
  61.   Cookies.info
  62.   Cookies.txt
  63. *NOT* Cookies.txt.info.  This will cause problems!
  64.  
  65.  
  66. B. From Shell
  67.  
  68. Ensure that you are in the directory in which you have places Cookies.txt.
  69. Type
  70.   cookies
  71. at the Shell prompt.  The program will pick a cookie, display it in the
  72. Shell window, and exit.  This is good for generating random .signature files
  73. for email.  You could put something like
  74.   cookies >S:.signature
  75. in your Startup-Sequence and have a different email signature every time you
  76. boot.
  77.  
  78. Cookies takes one switch from the Shell: WINDOW.  It instructs the program
  79. to act as if it is run from Workbench.  So you could do something like
  80.   run <NIL: >NIL: cookies window
  81. in your Startup-Sequence and have it run everytime you boot up, just for
  82. laughs!
  83.  
  84. If you run in the Shell without WINDOW mode on, it won't attempt to open
  85. reqtools.library, as the requester functions are not needed just for writing
  86. to the Shell.  So if you can't/don't/won't install reqtools.library, you
  87. can still use Cookies.  You lucky people! :-)
  88.  
  89.  
  90. 4. Cookies.txt file format
  91. --------------------------
  92. You put the messages one by one in the file, with a blank line between each
  93. one, and the cursor stopping on a blank line at the end of the file.  For
  94. example, a legal (but short) cookies.txt would be:
  95.  
  96. No matter where you go, there you are.
  97.  
  98. "Doctor, Doctor, I've broken my arm in three places."
  99. "Then you shouldn't go to those places"
  100.  
  101. Life, don't talk to me about life...
  102. #
  103.  
  104. (The hash symbol represents where the cursor finishes up in the editor.
  105. There are no lines after this).
  106. The above file contains three cookies; the first and third have one line
  107. each; the second has two lines.  You may have up to nine lines per cookie.
  108. Examine the included Cookies.txt to get to know the file format; it really
  109. is easy.  Once you've got to grips with it (which should take all of two
  110. seconds), you can add more cookies to it.  I keep mine in alphabetical
  111. order; this is not compulsory.
  112.  
  113. You can put blank lines in your cookies, eg if you wanted something like:
  114. If God is for us, who can be against us?
  115.  
  116. Romans 8:31
  117.  
  118. to appear, place one or more spaces on the line you wish to be left blank.
  119.  
  120. I got these cookies mainly from the fortune.txt file in with the NorthC
  121. distribution by Steve Hawtin.  I removed the rude ones and added some more.
  122. I also changed the file format to make it easier (I think :-) to process.
  123. My program code is not based in any way on Steve's; it is my own work.
  124.  
  125.  
  126. 5. Bugs
  127. -------
  128. Cookies is SLOOOOOOW from floppy disk.  Sorry :-(  It runs at a perfectly
  129. acceptable speed from hard disk.  This may be fixed in a later version by
  130. reading the entire Cookies.txt into memory.
  131.  
  132. Each cookie can have only a maximum of 255 characters.  This includes
  133. newlines, and the "Thought for the day..." message which appears at the
  134. beginning.  I think 255 chars should be enough for most people.  This is
  135. a restriction in HS Pascal and there is nothing I can do about it, short
  136. of buying a C compiler, and I don't want to do that...
  137.  
  138. Cookies has been tested under AmigaOS 1.3, 3.0, and 3.1, on various machine
  139. architectures and configurations.  It performed admirably in each case.
  140.  
  141.  
  142. 6. History
  143. ----------
  144. Cookies v0.1
  145. Pitiful, bugged, lame... it worked (just); that was about all.
  146.  
  147. Cookies v0.2
  148. Now we are getting somewhere.  This version was cleaner.  There's a lot
  149. wrong with it though - window opens quite big, no matter how long the
  150. message.  You can only display one message; then you have to quit and re-
  151. load (yawn).
  152.  
  153. Cookies v0.21
  154. A bug fix - the window title sometimes got corrupted.
  155.  
  156. Cookies v0.22
  157. The window now re-sizes around the message.
  158. Some more bugs fixed, and lots of little changes to the code.
  159.  
  160. Cookies v0.30
  161. File handling is now a little faster, though not as fast as I'd like...
  162. Window initially opens as small as possible, and expands to accomodate the
  163.   message.
  164. More memory efficient.
  165. Text has 1 pixel extra space between lines (easier to read)
  166. This is the first 'multiple-cookie' version - you can now load another
  167.   cookie by pressing the right mouse button when the window is active.  This
  168.   is a time saver if you happen to be in a cookie mood.
  169. Code reorganized using ARP library to make my life easier.
  170.  
  171. Cookies v0.31 PUBLIC RELEASE
  172. Got rid of ARP; I could manage okay without.
  173.  
  174. Cookies v0.32 PUBLIC RELEASE
  175. Code cleaned up a little; now a bit more efficient.  Functionality is
  176. exactly the same as v0.31.
  177.  
  178. Cookies v0.32a, b, c
  179. Bug fixes and code cleanup.  Recompiled using AmigaOS 3.1 includes
  180.  
  181. Cookies v0.4
  182. First Reqtools version.  Now opens a nice window with buttons and stuff.
  183. 'About' feature added
  184.  
  185. Cookies v0.41 PUBLIC RELEASE
  186. 'Specific' feature added
  187. Now can print a cookie straight to Shell window, doesn't need reqtools
  188.   for this
  189.  
  190.  
  191. 7. Plans for the future
  192. -----------------------
  193. Rewrite without Reqtools, using just Intuition requesters.  Might take a
  194.   while as I have no Intuition autodocs.  Anybody wanna buy me an RKM? :-)
  195. Implement support for PowerPacked cookie files using powerpacker.library,
  196.   or even other crunchers using xfdmaster.library.
  197. Read the entire file into memory; operation is faster, with the trade-off
  198.   that the program might need over 100Kb to run.
  199.  
  200.  
  201. 8. All about me
  202. ---------------
  203. I am a student with enough spare time to write useless programs in Pascal;
  204. I'm not actually wasting my time; this is good practice.  It also beats
  205. coding Amiga stuff in C, which is (1) confusing and (2) expensive.  This
  206. proggy was written in HS Pascal, which was not that cheap, but cheaper (and
  207. friendlier :-) than C.
  208.  
  209. If you wanna contact me, you can do so by email during University term time.
  210. Just point your mailer at:
  211.  
  212.   steffan@dcs.warwick.ac.uk
  213.  
  214. or you can send snail mail to:
  215.  
  216.   Stephen Williams,
  217.   9, Helmsley Way,
  218.   Spalding,
  219.   Lincolnshire,
  220.   PE12 6BG,
  221.   England.
  222.  
  223. I also have a World Wide Web page:
  224.  
  225.   http://www.warwick.ac.uk/~csuxg/
  226.  
  227. The latest version of Cookies should always be available from here, or from
  228. the Aminet.
  229.  
  230. Please pass Cookies on to your Amiga-owning friends.  It's fun and, well,
  231. somebody might like it.  Perhaps.
  232.  
  233. Cookies is Message-ware.  This is like Freeware (ie the program is free but
  234. you can't mess about with it), except that if you use it, I'd like it if
  235. you'd email me or write a letter.  I would also be grateful if you'd send
  236. me some feedback about Cookies.
  237.  
  238.  
  239. 9. Credits
  240. ----------
  241. reqtools.library and associated development tools were written by Nico
  242. Francois.  Thanks Nico :-)
  243.  
  244.  
  245. 10. Other stuff by me
  246. ---------------------
  247. I have also written numerous MED modules.  If you want a listen then email
  248. me and I'll send one back to you.
  249.  
  250. Okay, end of doc.  Boredom over...
  251.  
  252. Byeeeeeee.......
  253.  
  254.